Skip to main content

Update Payment

PUT /api/v1/InvoiceSetting/UpdatePayment

Description​

This endpoint is used to update payment method settings. It allows users to modify the payment method settings for invoices.

Headers:

  • Content-Type: application/json

ApiKey:

  • No API key required

Path Parameters:

  • version: string, required

Request Body:

  • UpdatePaymentMethodSettings object containing the updated payment method settings

URL:

  • PUT: {{baseUrl API url}}/api/v1/InvoiceSetting/UpdatePayment

Response:

  • 200: Success, indicates that the payment method settings have been successfully updated.

Error Codes:

  • 400: Bad Request, the request body is not valid or missing required fields.

  • 404: Resource not found, the specified version or setting does not exist.

  • 500: Internal server error, something went wrong while processing the request.

Example Request URL:

PUT /api/v1/InvoiceSetting/UpdatePayment
Content-Type: application/json
{
  "paymentMethod": "Credit Card",
  "gateway": "Stripe",
  "accountNumber": "1234567890",
  "isActive": true
}

Example Response:

HTTP/1.1 200 OK

Notes:

  • The request body should contain the UpdatePaymentMethodSettings object, which includes the updated payment method settings.

  • The response indicates that the payment method settings have been successfully updated.

Method: PUT​

/api/v1/InvoiceSetting/UpdatePayment

Headers​

Content-TypeValue
Content-Typeapplication/json

Body (raw)​

{
  "paymentMethodSettingId": "<uuid>",
  "paymentMethods": [
    "<integer>",
    "<integer>"
  ]
}

Response: 200​

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request PUT \ 
 --url  /api/v1/InvoiceSetting/UpdatePayment \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!